home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / content / nsIXPointer.h < prev    next >
C/C++ Source or Header  |  2006-05-08  |  12KB  |  370 lines
  1. /*
  2.  * DO NOT EDIT.  THIS FILE IS GENERATED FROM nsIXPointer.idl
  3.  */
  4.  
  5. #ifndef __gen_nsIXPointer_h__
  6. #define __gen_nsIXPointer_h__
  7.  
  8.  
  9. #ifndef __gen_nsISupports_h__
  10. #include "nsISupports.h"
  11. #endif
  12.  
  13. /* For IDL files that don't want to include root IDL files. */
  14. #ifndef NS_NO_VTABLE
  15. #define NS_NO_VTABLE
  16. #endif
  17. class nsIDOMRange; /* forward declaration */
  18.  
  19. class nsIDOMDocument; /* forward declaration */
  20.  
  21.  
  22. /* starting interface:    nsIXPointerResult */
  23. #define NS_IXPOINTERRESULT_IID_STR "d3992637-f474-4b65-83ed-323fe69c60d2"
  24.  
  25. #define NS_IXPOINTERRESULT_IID \
  26.   {0xd3992637, 0xf474, 0x4b65, \
  27.     { 0x83, 0xed, 0x32, 0x3f, 0xe6, 0x9c, 0x60, 0xd2 }}
  28.  
  29. /**
  30.  * XXX A good XPointerResult would probably mimic XPathresult,
  31.  *     this range list is just the minimum that will be able to represent
  32.  *     all return values, although it would be more user friendly to return
  33.  *     nodes and node lists when they are possible.
  34.  */
  35. class NS_NO_VTABLE nsIXPointerResult : public nsISupports {
  36.  public: 
  37.  
  38.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IXPOINTERRESULT_IID)
  39.  
  40.   /* nsIDOMRange item (in unsigned long index); */
  41.   NS_IMETHOD Item(PRUint32 index, nsIDOMRange **_retval) = 0;
  42.  
  43.   /* readonly attribute unsigned long length; */
  44.   NS_IMETHOD GetLength(PRUint32 *aLength) = 0;
  45.  
  46. };
  47.  
  48. /* Use this macro when declaring classes that implement this interface. */
  49. #define NS_DECL_NSIXPOINTERRESULT \
  50.   NS_IMETHOD Item(PRUint32 index, nsIDOMRange **_retval); \
  51.   NS_IMETHOD GetLength(PRUint32 *aLength); 
  52.  
  53. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  54. #define NS_FORWARD_NSIXPOINTERRESULT(_to) \
  55.   NS_IMETHOD Item(PRUint32 index, nsIDOMRange **_retval) { return _to Item(index, _retval); } \
  56.   NS_IMETHOD GetLength(PRUint32 *aLength) { return _to GetLength(aLength); } 
  57.  
  58. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  59. #define NS_FORWARD_SAFE_NSIXPOINTERRESULT(_to) \
  60.   NS_IMETHOD Item(PRUint32 index, nsIDOMRange **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->Item(index, _retval); } \
  61.   NS_IMETHOD GetLength(PRUint32 *aLength) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetLength(aLength); } 
  62.  
  63. #if 0
  64. /* Use the code below as a template for the implementation class for this interface. */
  65.  
  66. /* Header file */
  67. class nsXPointerResult : public nsIXPointerResult
  68. {
  69. public:
  70.   NS_DECL_ISUPPORTS
  71.   NS_DECL_NSIXPOINTERRESULT
  72.  
  73.   nsXPointerResult();
  74.  
  75. private:
  76.   ~nsXPointerResult();
  77.  
  78. protected:
  79.   /* additional members */
  80. };
  81.  
  82. /* Implementation file */
  83. NS_IMPL_ISUPPORTS1(nsXPointerResult, nsIXPointerResult)
  84.  
  85. nsXPointerResult::nsXPointerResult()
  86. {
  87.   /* member initializers and constructor code */
  88. }
  89.  
  90. nsXPointerResult::~nsXPointerResult()
  91. {
  92.   /* destructor code */
  93. }
  94.  
  95. /* nsIDOMRange item (in unsigned long index); */
  96. NS_IMETHODIMP nsXPointerResult::Item(PRUint32 index, nsIDOMRange **_retval)
  97. {
  98.     return NS_ERROR_NOT_IMPLEMENTED;
  99. }
  100.  
  101. /* readonly attribute unsigned long length; */
  102. NS_IMETHODIMP nsXPointerResult::GetLength(PRUint32 *aLength)
  103. {
  104.     return NS_ERROR_NOT_IMPLEMENTED;
  105. }
  106.  
  107. /* End of implementation class template. */
  108. #endif
  109.  
  110.  
  111. /* starting interface:    nsIXPointerSchemeContext */
  112. #define NS_IXPOINTERSCHEMECONTEXT_IID_STR "781f4aa1-ebb3-4667-b1c2-2b35e94c4281"
  113.  
  114. #define NS_IXPOINTERSCHEMECONTEXT_IID \
  115.   {0x781f4aa1, 0xebb3, 0x4667, \
  116.     { 0xb1, 0xc2, 0x2b, 0x35, 0xe9, 0x4c, 0x42, 0x81 }}
  117.  
  118. /**
  119.  * Scheme context for nsIXPointerSchemeProcessor. The context consists of
  120.  * all the scheme/data pairs that precede the scheme/data that the
  121.  * nsIXPointerSchemeProcessor is currently evaluating.
  122.  */
  123. class NS_NO_VTABLE nsIXPointerSchemeContext : public nsISupports {
  124.  public: 
  125.  
  126.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IXPOINTERSCHEMECONTEXT_IID)
  127.  
  128.   /* readonly attribute unsigned long count; */
  129.   NS_IMETHOD GetCount(PRUint32 *aCount) = 0;
  130.  
  131.   /* void getSchemeData (in unsigned long index, out DOMString scheme, out DOMString data); */
  132.   NS_IMETHOD GetSchemeData(PRUint32 index, nsAString & scheme, nsAString & data) = 0;
  133.  
  134. };
  135.  
  136. /* Use this macro when declaring classes that implement this interface. */
  137. #define NS_DECL_NSIXPOINTERSCHEMECONTEXT \
  138.   NS_IMETHOD GetCount(PRUint32 *aCount); \
  139.   NS_IMETHOD GetSchemeData(PRUint32 index, nsAString & scheme, nsAString & data); 
  140.  
  141. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  142. #define NS_FORWARD_NSIXPOINTERSCHEMECONTEXT(_to) \
  143.   NS_IMETHOD GetCount(PRUint32 *aCount) { return _to GetCount(aCount); } \
  144.   NS_IMETHOD GetSchemeData(PRUint32 index, nsAString & scheme, nsAString & data) { return _to GetSchemeData(index, scheme, data); } 
  145.  
  146. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  147. #define NS_FORWARD_SAFE_NSIXPOINTERSCHEMECONTEXT(_to) \
  148.   NS_IMETHOD GetCount(PRUint32 *aCount) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCount(aCount); } \
  149.   NS_IMETHOD GetSchemeData(PRUint32 index, nsAString & scheme, nsAString & data) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetSchemeData(index, scheme, data); } 
  150.  
  151. #if 0
  152. /* Use the code below as a template for the implementation class for this interface. */
  153.  
  154. /* Header file */
  155. class nsXPointerSchemeContext : public nsIXPointerSchemeContext
  156. {
  157. public:
  158.   NS_DECL_ISUPPORTS
  159.   NS_DECL_NSIXPOINTERSCHEMECONTEXT
  160.  
  161.   nsXPointerSchemeContext();
  162.  
  163. private:
  164.   ~nsXPointerSchemeContext();
  165.  
  166. protected:
  167.   /* additional members */
  168. };
  169.  
  170. /* Implementation file */
  171. NS_IMPL_ISUPPORTS1(nsXPointerSchemeContext, nsIXPointerSchemeContext)
  172.  
  173. nsXPointerSchemeContext::nsXPointerSchemeContext()
  174. {
  175.   /* member initializers and constructor code */
  176. }
  177.  
  178. nsXPointerSchemeContext::~nsXPointerSchemeContext()
  179. {
  180.   /* destructor code */
  181. }
  182.  
  183. /* readonly attribute unsigned long count; */
  184. NS_IMETHODIMP nsXPointerSchemeContext::GetCount(PRUint32 *aCount)
  185. {
  186.     return NS_ERROR_NOT_IMPLEMENTED;
  187. }
  188.  
  189. /* void getSchemeData (in unsigned long index, out DOMString scheme, out DOMString data); */
  190. NS_IMETHODIMP nsXPointerSchemeContext::GetSchemeData(PRUint32 index, nsAString & scheme, nsAString & data)
  191. {
  192.     return NS_ERROR_NOT_IMPLEMENTED;
  193. }
  194.  
  195. /* End of implementation class template. */
  196. #endif
  197.  
  198. /**
  199.  * nsIXPointerSchemeProcessor implementations must be registered with the below
  200.  * progid, appended with the scheme name that the processor implements.
  201.  */
  202. #define NS_XPOINTER_SCHEME_PROCESSOR_BASE "@mozilla.org/xml/xpointer;1?scheme="
  203.  
  204. /* starting interface:    nsIXPointerSchemeProcessor */
  205. #define NS_IXPOINTERSCHEMEPROCESSOR_IID_STR "093d3559-b56b-44d0-8764-c25815715080"
  206.  
  207. #define NS_IXPOINTERSCHEMEPROCESSOR_IID \
  208.   {0x093d3559, 0xb56b, 0x44d0, \
  209.     { 0x87, 0x64, 0xc2, 0x58, 0x15, 0x71, 0x50, 0x80 }}
  210.  
  211. /**
  212.  * nsIXPointerSchemeProcessors will be called by the XPointer Processor that
  213.  * implements the XPointer Framework. This is done for each scheme the
  214.  * XPointer Processor finds, in left-to-right order.
  215.  */
  216. class NS_NO_VTABLE nsIXPointerSchemeProcessor : public nsISupports {
  217.  public: 
  218.  
  219.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IXPOINTERSCHEMEPROCESSOR_IID)
  220.  
  221.   /**
  222.    * Evaluate.
  223.    *
  224.    * @param aDocument The document in which to resolve the XPointer.
  225.    * @param aContext  The XPointer context in which to process aData.
  226.    * @param aData     The data in the scheme that needs to be resolved.
  227.    * @return          The result of the evaluation.
  228.    */
  229.   /* nsIXPointerResult evaluate (in nsIDOMDocument aDocument, in nsIXPointerSchemeContext aContext, in DOMString aData); */
  230.   NS_IMETHOD Evaluate(nsIDOMDocument *aDocument, nsIXPointerSchemeContext *aContext, const nsAString & aData, nsIXPointerResult **_retval) = 0;
  231.  
  232. };
  233.  
  234. /* Use this macro when declaring classes that implement this interface. */
  235. #define NS_DECL_NSIXPOINTERSCHEMEPROCESSOR \
  236.   NS_IMETHOD Evaluate(nsIDOMDocument *aDocument, nsIXPointerSchemeContext *aContext, const nsAString & aData, nsIXPointerResult **_retval); 
  237.  
  238. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  239. #define NS_FORWARD_NSIXPOINTERSCHEMEPROCESSOR(_to) \
  240.   NS_IMETHOD Evaluate(nsIDOMDocument *aDocument, nsIXPointerSchemeContext *aContext, const nsAString & aData, nsIXPointerResult **_retval) { return _to Evaluate(aDocument, aContext, aData, _retval); } 
  241.  
  242. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  243. #define NS_FORWARD_SAFE_NSIXPOINTERSCHEMEPROCESSOR(_to) \
  244.   NS_IMETHOD Evaluate(nsIDOMDocument *aDocument, nsIXPointerSchemeContext *aContext, const nsAString & aData, nsIXPointerResult **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->Evaluate(aDocument, aContext, aData, _retval); } 
  245.  
  246. #if 0
  247. /* Use the code below as a template for the implementation class for this interface. */
  248.  
  249. /* Header file */
  250. class nsXPointerSchemeProcessor : public nsIXPointerSchemeProcessor
  251. {
  252. public:
  253.   NS_DECL_ISUPPORTS
  254.   NS_DECL_NSIXPOINTERSCHEMEPROCESSOR
  255.  
  256.   nsXPointerSchemeProcessor();
  257.  
  258. private:
  259.   ~nsXPointerSchemeProcessor();
  260.  
  261. protected:
  262.   /* additional members */
  263. };
  264.  
  265. /* Implementation file */
  266. NS_IMPL_ISUPPORTS1(nsXPointerSchemeProcessor, nsIXPointerSchemeProcessor)
  267.  
  268. nsXPointerSchemeProcessor::nsXPointerSchemeProcessor()
  269. {
  270.   /* member initializers and constructor code */
  271. }
  272.  
  273. nsXPointerSchemeProcessor::~nsXPointerSchemeProcessor()
  274. {
  275.   /* destructor code */
  276. }
  277.  
  278. /* nsIXPointerResult evaluate (in nsIDOMDocument aDocument, in nsIXPointerSchemeContext aContext, in DOMString aData); */
  279. NS_IMETHODIMP nsXPointerSchemeProcessor::Evaluate(nsIDOMDocument *aDocument, nsIXPointerSchemeContext *aContext, const nsAString & aData, nsIXPointerResult **_retval)
  280. {
  281.     return NS_ERROR_NOT_IMPLEMENTED;
  282. }
  283.  
  284. /* End of implementation class template. */
  285. #endif
  286.  
  287.  
  288. /* starting interface:    nsIXPointerEvaluator */
  289. #define NS_IXPOINTEREVALUATOR_IID_STR "addd0fe5-8555-45b7-b763-97d5898ce268"
  290.  
  291. #define NS_IXPOINTEREVALUATOR_IID \
  292.   {0xaddd0fe5, 0x8555, 0x45b7, \
  293.     { 0xb7, 0x63, 0x97, 0xd5, 0x89, 0x8c, 0xe2, 0x68 }}
  294.  
  295. /**
  296.  * nsIXPointerEvaluator resolves an XPointer expression
  297.  */
  298. class NS_NO_VTABLE nsIXPointerEvaluator : public nsISupports {
  299.  public: 
  300.  
  301.   NS_DEFINE_STATIC_IID_ACCESSOR(NS_IXPOINTEREVALUATOR_IID)
  302.  
  303.   /**
  304.    * Evaluate an XPointer expression.
  305.    *
  306.    * @param aDocument   The document in which to evaluate.
  307.    * @param aExpression The XPointer expression string to evaluate.
  308.    * @return            The result.
  309.    */
  310.   /* nsIXPointerResult evaluate (in nsIDOMDocument aDocument, in DOMString aExpression); */
  311.   NS_IMETHOD Evaluate(nsIDOMDocument *aDocument, const nsAString & aExpression, nsIXPointerResult **_retval) = 0;
  312.  
  313. };
  314.  
  315. /* Use this macro when declaring classes that implement this interface. */
  316. #define NS_DECL_NSIXPOINTEREVALUATOR \
  317.   NS_IMETHOD Evaluate(nsIDOMDocument *aDocument, const nsAString & aExpression, nsIXPointerResult **_retval); 
  318.  
  319. /* Use this macro to declare functions that forward the behavior of this interface to another object. */
  320. #define NS_FORWARD_NSIXPOINTEREVALUATOR(_to) \
  321.   NS_IMETHOD Evaluate(nsIDOMDocument *aDocument, const nsAString & aExpression, nsIXPointerResult **_retval) { return _to Evaluate(aDocument, aExpression, _retval); } 
  322.  
  323. /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
  324. #define NS_FORWARD_SAFE_NSIXPOINTEREVALUATOR(_to) \
  325.   NS_IMETHOD Evaluate(nsIDOMDocument *aDocument, const nsAString & aExpression, nsIXPointerResult **_retval) { return !_to ? NS_ERROR_NULL_POINTER : _to->Evaluate(aDocument, aExpression, _retval); } 
  326.  
  327. #if 0
  328. /* Use the code below as a template for the implementation class for this interface. */
  329.  
  330. /* Header file */
  331. class nsXPointerEvaluator : public nsIXPointerEvaluator
  332. {
  333. public:
  334.   NS_DECL_ISUPPORTS
  335.   NS_DECL_NSIXPOINTEREVALUATOR
  336.  
  337.   nsXPointerEvaluator();
  338.  
  339. private:
  340.   ~nsXPointerEvaluator();
  341.  
  342. protected:
  343.   /* additional members */
  344. };
  345.  
  346. /* Implementation file */
  347. NS_IMPL_ISUPPORTS1(nsXPointerEvaluator, nsIXPointerEvaluator)
  348.  
  349. nsXPointerEvaluator::nsXPointerEvaluator()
  350. {
  351.   /* member initializers and constructor code */
  352. }
  353.  
  354. nsXPointerEvaluator::~nsXPointerEvaluator()
  355. {
  356.   /* destructor code */
  357. }
  358.  
  359. /* nsIXPointerResult evaluate (in nsIDOMDocument aDocument, in DOMString aExpression); */
  360. NS_IMETHODIMP nsXPointerEvaluator::Evaluate(nsIDOMDocument *aDocument, const nsAString & aExpression, nsIXPointerResult **_retval)
  361. {
  362.     return NS_ERROR_NOT_IMPLEMENTED;
  363. }
  364.  
  365. /* End of implementation class template. */
  366. #endif
  367.  
  368.  
  369. #endif /* __gen_nsIXPointer_h__ */
  370.